home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / doors_2 / sfcantrv.zip / SFCANTRV.DOC < prev    next >
Text File  |  1990-09-13  |  20KB  |  496 lines
  1.  
  2.  
  3.                              F R E E W A R E
  4.  
  5.                                  f r o m
  6.  
  7.  
  8.                      ╔════════════════════════════════╗
  9.                      ║                                ║
  10.                      ║     █▄                  ▄█     ║
  11.                      ║    ▒░█▀██████    █████▀██░▒    ║
  12.                      ║   ▓▒░███████▀    ▀███████░▒▓   ║
  13.                      ║   ▓▒░███▀            ▀███░▒▓   ║
  14.                      ║   ▓▒░███▄            ▄███░▒▓   ║
  15.                      ║   ▓▒░████▄          ▄████░▒▓   ║
  16.                      ║    ▒░██████▄      ▄██████░▒    ║
  17.                      ║     ████████      ████████     ║
  18.                      ║    ▄▄▄▄▄▄▄▄▄▄    ▄▄▄▄▄▄▄▄▄▄    ║
  19.                      ║    ▄▄▄▄▄▄▄▄▄▄    ▄▄▄▄▄▄▄▄▄▄    ║
  20.                      ║                                ║
  21.                      ╚════════════════════════════════╝
  22.  
  23.                      ╔════════════════════════════════╗
  24.                      ║                                ║
  25.                      ║ ╔═╗ ╔   ╔═╗ ╔═╗ ╔╦╗ ╔═╗  ╦ ╔═╗ ║
  26.                      ║ ╠═  ║   ╠═  ║    ║  ╠═╚╗ ║ ║   ║
  27.                      ║ ╚═╝ ╚═╝ ╚═╝ ╚═╝  ╩  ╩  ╩ ╩ ╚═╝ ║
  28.                      ║   ╦ ╦  ╔╗╦ ╦ ╔═╗ ╦ ╦ ╔╦╗ ╔═╗   ║
  29.                      ║   ╠═╚╗ ║║║ ║ ╠═╗ ╠═╣  ║  ╚═╗   ║
  30.                      ║   ╩  ╩ ╩╚╝ ╩ ╚═╝ ╩ ╩  ╩  ╚═╝   ║
  31.                      ║          ╦═╗ ╦═╗ ╔═╗           ║
  32.                      ║          ╠═╣ ╠═╣ ╚═╗           ║
  33.                      ║          ╩═╝ ╩═╝ ╚═╝           ║
  34.                      ╠════════════════════════════════╣
  35.                      ║    A Registered SPITFIRE BBS   ║
  36.                      ╚════════════════════════════════╝
  37.  
  38.                                 #SF300279
  39.  
  40.                   2400/1200/300 * 8/N/1 * (519) 442-6449
  41.  
  42.  
  43.                            in cooperation with
  44.                           Buffalo Creek Software
  45.  
  46.  
  47.  
  48.  
  49.  
  50.  
  51.  
  52.  
  53.  
  54.  
  55.  
  56.  
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.  
  64.  
  65.  
  66.                                  SFCANTRV
  67.                        SPITFIRE CANADIAN TRIVIA DOOR
  68.                                 Version 1.0
  69.                             by Heather Story of
  70.                            ELECTRIC KNIGHTS BBS
  71.  
  72.  
  73.    INTRODUCTION
  74.    ------------
  75.  
  76.    SFCANTRV is a fast paced Canadiana trivia game designed to run as a
  77.    door feature within the SPITFIRE Bulletin Board System.  It can also
  78.    be installed as a sysop configurable command from the Main, File or
  79.    Message menus of SPITFIRE.  A data file containing 506 Canadian
  80.    trivia questions is randomly accessed and displayed to the screen.
  81.    With each question that is displayed, four multiple choice options
  82.    are provided from which the player may select.  SFCANTRV allows the
  83.    SYSOP to configure the delay time (defaults to ten seconds) that the
  84.    player is allowed to read the question and respond with the number
  85.    corresponding to the answer they wish to select.
  86.  
  87.  
  88.    SFCANTRV COMMAND LINE PARAMETERS
  89.    --------------------------------
  90.  
  91.       /P - Designates the drive, path, filename and extension of the
  92.            high score bulletin to be used with SFCANTRV
  93.  
  94.       /D - Designates the delay time (in seconds) that the user is
  95.            allowed to answer the question before it "times out".
  96.  
  97.       /L - Allows local usage of SFCANTRV
  98.  
  99.  
  100.    The /P command line parameter is available which will automatically
  101.    create Ansi and Non-Ansi high score bulletins for your BBS system.
  102.    If you would like to use this option, a "/P" should follow the
  103.    SFCANTRV in the command line to indicate a valid DOS path where the
  104.    bulletin file will be created.  (NOTE: This should be the same as the
  105.    display file path you have set up within SPITFIRE.)  The path is then
  106.    followed by the file name of the bulletin to be created.  It is not
  107.    necessary to include the file extension.  SFCANTRV will automatically
  108.    add a .BBS extension for the Non-Ansi display file and a .CLR
  109.    extension for the Ansi display file created.  The correct syntax
  110.    should look like this:
  111.  
  112.    SFCANTRV /P C:\SF\DISPLAY\DORBUL1
  113.  
  114.    The "/P" command line is optional and SFCANTRV will operate perfectly
  115.    fine without it.  However, it is a convenient means of providing and
  116.    posting high score bulletins for the Canadiana trivia door.
  117.  
  118.  
  119.    The /D command line parameter is also available which will allow the
  120.    Sysop to designate the delay time (in seconds) that is allowed
  121.    between the time the question prompt is displayed to the screen and
  122.    when the user must enter the desired answer.  This is done using the
  123.    /Dnn (where nn represents the number of seconds) command line
  124.    parameter.  As an example, if the Sysop wishes to allow a 15 second
  125.    delay, a /D15 would be entered on the command line as illustrated
  126.    below:
  127.  
  128.    SFCANTRV /D15
  129.  
  130.    If no /Dnn is designated at the command line, SFCANTRV will default
  131.    to a ten second delay.
  132.  
  133.  
  134.    The /L command line parameter will allow SFCANTRV to be played
  135.    locally without requiring a SFDOORS.DAT, SFMAIN.DAT, SFMESS.DAT or
  136.    SFFILE.DAT file.  Using the /L command line parameter disables the
  137.    program's carrier detect monitoring and redirection of the game
  138.    through the comm port.  For local operation of SFCANTRV enter the
  139.    following command at the DOS prompt:
  140.  
  141.    C:> SFCANTRV /L
  142.  
  143.    ** SPECIAL NOTE ** The /L, /P and /D command parameters can be used
  144.    together in one command line to specify the drive, path and filename
  145.    of the bulletin to be created and the delay time in seconds when
  146.    playing in local mode.
  147.  
  148.    It should also be noted that the /P, /D and /L command line
  149.    parameters may appear in any order on the command line.  SFCANTRV
  150.    does NOT require these to be used in a specific order.
  151.  
  152.  
  153.  
  154.    SFCANTRV SETUP AS A SPITFIRE DOOR
  155.    ---------------------------------
  156.  
  157.    To set up SFCANTRV to be executed as a door, it is recommended that a
  158.    separate directory be set up for it.  For explanation purposes, let's
  159.    assume the directory DOORA is created for use with SFCANTRV.  The
  160.    following files must then be placed in the directory:
  161.  
  162.    SFCANTRV.EXE    The actual game program.
  163.  
  164.    SFCANTRV.DAT    The data file containing the trivia questions.
  165.  
  166.    SFCANTRV.TOP    This is a listing of the top ten players.  SFCANTRV.EXE
  167.                    will create this file if it is not found.
  168.  
  169.    SFCANTRV.LMT    This allows you to set time limits according to the
  170.                    callers security level.
  171.  
  172.    The Sysop will then need to use a text editor to edit the SF.BAT file
  173.    as illustrated below:
  174.  
  175.    :DOOR_A
  176.    COPY SFDOORS.DAT C:\SF\DOORA
  177.    SFCANTRV
  178.    ERASE SFDOORS.DAT
  179.    GOTO LOOP
  180.    :DOOR_B
  181.  
  182.  
  183.    You will notice that the commands needed to execute SFCANTRV are
  184.    placed between the :DOOR_A and GOTO LOOP command lines.  These are
  185.    entered in place of the existing REM Place Program Name Here.  The
  186.    following will briefly explain each of the commands which were set up
  187.    within SF.BAT to run SFCANTRV as a SPITFIRE Door program:
  188.  
  189.    SFDOORS.DAT is created automatically by SPITFIRE when a user enters a
  190.    door.  It contains information about the user such as name and
  191.    password.  SFCANTRV requires access to the information within
  192.    SFDOORS.DAT.  Therefore, before executing the program it must be
  193.    copied to the directory in which SFCANTRV is running.
  194.  
  195.    SFCANTRV is the program name and executes the game program from
  196.    within the door program.
  197.  
  198.    Once the user has terminated the game play of SFCANTRV, SPITFIRE
  199.    erases the SFDOORS.DAT file.
  200.  
  201.  
  202.  
  203.    SFCANTRV SETUP AS A SYSOP CONFIGURABLE COMMAND
  204.    ----------------------------------------------
  205.  
  206.    SPITFIRE has a sysop configurable command for the Main, Message and
  207.    File menus.  The sysop configurable command is executed through a
  208.    batch file which corresponds to the menu it is being run from.  In
  209.    other words, SFMAIN.BAT runs the sysop configurable command from the
  210.    Main Menu, SFMESS.BAT runs the one from the Message Menu and
  211.    SFFILE.BAT the one from the File Menu.  The commands necessary to
  212.    execute SFCANTRV can be set up in the batch file which corresponds to
  213.    the menu you wish to have SFCANTRV run from.
  214.  
  215.    The first thing you will need to establish is which of these menus
  216.    you wish to use to run SFCANTRV.  For this purpose, let's assume that
  217.    it is going to be set up so it can be run from the Main Menu.  (It
  218.    should be noted the set up procedure is the same regardless of which
  219.    Menu you are running SFCANTRV from.)
  220.  
  221.    Next, you will need to decide what you wish to name the command
  222.    option and establish what security level will be required for users
  223.    of your system to be able to access this option.  Once this is
  224.    determined you will need to modify the SFMAIN.MNU file using your
  225.    favorite text editor, as long as it saves in ASCII format.  (Refer to
  226.    the SPITFIRE manual for further documentation on this if needed.  It
  227.    should also be noted that if SFCANTRV were being set up to run from
  228.    the File Menu, you would need to modify the SFFILE.MNU file and if it
  229.    was being set up to be run from the Message Menu you would need to
  230.    modify the SFMSG.MNU file.)
  231.  
  232.  
  233.    Examining the default SFMAIN.MNU file, you will notice the sysop
  234.    configurable command appears as:
  235.  
  236.         <K>............. Add Your Own,,1000,@
  237.  
  238.  
  239.    This will need to be replaced with a Command Character that will be
  240.    used to select the option from the menu.  It is ABSOLUTELY IMPERATIVE
  241.    that the Command Character must not duplicate an existing Command
  242.    Character for another menu option.  You will then need to include a
  243.    brief description of the Wildcat door program you are running, two
  244.    commas, the security level required to access this feature, and
  245.    another comma followed by the a @.  The @ must not be changed!  (For
  246.    more detailed information on modifying your SFMAIN.MNU, SFMSG.MNU or
  247.    SFFILE.MNU refer to your SPITFIRE manual.)
  248.  
  249.        <K>.... Brief Program Description,,10,@
  250.  
  251.    Now you will need to modify the corresponding batch file, SFMAIN.BAT,
  252.    so that it can be executed from the Main Menu.  Do this using your
  253.    favorite text editor, as long as it saves in ASCII format.  (Again,
  254.    it should be noted that if SFCANTRV were being set up to run from the
  255.    File Menu, you would need to modify the SFFILE.BAT file and if it was
  256.    being set up to be run from the Message Menu you would need to modify
  257.    the SFMESS.BAT file.)
  258.  
  259.    Place the SFCANTRV.EXE file in the directory you wish to run the
  260.    program from.  SFCANTRV will create its own player score file,
  261.    SFCANTRV.TOP, if does not already exist.
  262.  
  263.    The commands set up in the SFMAIN.BAT file are very similar to those
  264.    used for executing the game through a door in the SF.BAT file.  For
  265.    instance, if you were running SFCANTRV from the main SPITFIRE
  266.    directory your SFMAIN.BAT file might look like this:
  267.  
  268.        ECHO OFF
  269.        BRK OFF
  270.        SFCANTRV
  271.        BRK ON
  272.  
  273.    (BRK is not included in the SFCANTRV package because it is written
  274.    and copyrighted by Solid Systems, 1985, but can be downloaded from
  275.    The Mother Board BBS and Buffalo Creek's BBS as well as a number of
  276.    other BBS systems.  BRK is not required to run SFCANTRV, however, it
  277.    is recommended since it will prevent a user using the CTRL BRK
  278.    command to terminate the batch file, gaining access to your system at
  279.    the DOS level.)
  280.  
  281.    If you wish to set SFCANTRV up in a separate subdirectory from
  282.    SPITFIRE, for instance, a subdirectory named SFCANTRV, your batch
  283.    file might look like this.
  284.  
  285.        ECHO OFF
  286.        BRK OFF
  287.        COPY SFMAIN.DAT \SF\SFCANTRV
  288.        CD \SF\SFCANTRV
  289.        SFCANTRV
  290.        ERASE SFMAIN.DAT
  291.        CD \SF
  292.        BRK ON
  293.  
  294.  
  295.    When SFCANTRV is executed, from either the door with the SF.BAT file
  296.    or from the sysop configurable command through a menu with the
  297.    corresponding batch file, it will first look for the SFMAIN.DAT file,
  298.    then the SFMESS.DAT file, then the SFFILE.DAT file and lastly the
  299.    SFDOORS.DAT file.  It will look for each of these files until it
  300.    finds it and the commands required for its execution.  If none of
  301.    these files are found, SFCANTRV will halt its execution.
  302.  
  303.  
  304.    DTE LOCK FEATURE
  305.    ----------------
  306.  
  307.    SFCANTRV automatically detects if the DTE is locked at 19200 baud.
  308.    If SFCANTRV detects that the DTE is locked, then SFCANTRV opens the
  309.    serial port to the maximum baud rate of your system.  If SFCANTRV
  310.    does not detect that the DTE is locked, then the serial port is
  311.    opened to the baud rate of the caller.
  312.  
  313.  
  314.    SFCANTRV ON A MULTI-NODE SYSTEM
  315.    -------------------------------
  316.  
  317.    SFCANTRV is fully compatible for operation on a multi-node BBS.  It
  318.    automatically handles any file locking and file sharing required
  319.    during the doors execution.
  320.  
  321.  
  322.    SYSOP FEATURES
  323.    --------------
  324.  
  325.    First, a status line is now displayed on the BBS monitor that
  326.    provides information concerning the caller's name, baud rate of the
  327.    caller and the security level of the caller.
  328.  
  329.    A SFCANTRV.LMT file allows the sysop to establish a time limit for
  330.    door play according to the security level the caller has on the
  331.    system.  To modify the accompanying SFCANTRV.LMT file, use your
  332.    favorite text editor to represent the various security levels you
  333.    have available on your system, a comma then the corresponding time
  334.    you wish to allow for that particular security level in minutes.  For
  335.    instance, it might look like this:
  336.  
  337.    10,15
  338.    25,20
  339.    50,25
  340.    999,30
  341.  
  342.    Each security level should begin a new line and you should have a
  343.    setting for each security level you have available on your system.
  344.    If you do not have a time limit set for a particular security SFCANTRV
  345.    will default to the level 10 security level setting.
  346.  
  347.    Pressing the Shift Key and the F1 key simultaneously will terminate
  348.    game play of SFCANTRV and return the caller back to the BBS.
  349.    Pressing the Shift Key and the F9 key simultaneously will terminate
  350.    game play of SFCANTRV and log the caller off of the BBS.  If the
  351.    Shift Key and the F9 key are pressed together, logging the caller off
  352.    the BBS, SPITFIRE will recycle and return to the SPITFIRE Ready For
  353.    Caller Prompt.
  354.  
  355.  
  356.    SFCANTRV EXECUTION
  357.    ------------------
  358.  
  359.    When first executed, SFCANTRV will display a list of the Top Ten high
  360.    score players and the percentage of correct responses they achieved
  361.    while playing SFCANTRV.  Initially, this will be a dummy listing with
  362.    ten lines that display:
  363.  
  364.       0%...............YOUR NAME COULD BE HERE
  365.  
  366.    However, as the game is played, this will fill with the name of the
  367.    players, their percentage ratings and the date that the player was
  368.    added to the top ten listing.
  369.  
  370.    NOTE: At least twenty questions must be attempted before SFCANTRV
  371.          will will figure the percentage rating for the player.
  372.  
  373.    To keep things interesting...the Sysop can erase the file which
  374.    contains the top ten listings SFCANTRV.TOP on a routine basis to give
  375.    additional players a chance to have their name added to the list.
  376.  
  377.    As the top ten list is displayed, at the bottom of the screen is a
  378.    question which prompts the user whether they want to have ANSI
  379.    Graphics (y/n)?  available to them during game play.  If the user
  380.    responds with a y (for yes) the game will display in color and if the
  381.    user responds with a n (for no) the game will display in monochrome.
  382.  
  383.  
  384.  
  385.  
  386.  
  387.  
  388.  
  389.  
  390.  
  391.  
  392.  
  393.  
  394.  
  395.  
  396.    PLAYING SFCANTRV
  397.    ----------------
  398.  
  399.    Immediately after pressing any key (other than <Q> for Quit) from the
  400.    Top Ten listing the game screen is displayed.  The screen will look
  401.    like the following:
  402.  
  403.    ---------------------------------------------------------------------
  404.  
  405.     ╔═════════════════════════════════════════════╗
  406.     ║   >>>>>>>>>>> CANADIAN TRIVIA <<<<<<<<<<<   ║
  407.     ║                 Version 1.0                 ║
  408.     ║     Canadian Trivia Door For SPITFIRE!      ║
  409.     ║    Electric Knights BBS * (519) 442-6449    ║
  410.     ║ In Cooperation with Buffalo Creek Software  ║
  411.     ║     Copyright (C) by Heather Story, 1990    ║
  412.     ╚═════════════════════════════════════════════╝
  413.  
  414.     RIGHT: 0                        WRONG: 0
  415.  
  416.     QUESTION:
  417.     The Canadian trivia question will be displayed
  418.     here.
  419.  
  420.     <1> Choice 1                        <2> Choice 2
  421.     <3> Choice 3                        <4> Choice 4
  422.  
  423.              Enter Answer: [ 1 2 3 4 <Q>uit]?
  424.  
  425.    ---------------------------------------------------------------------
  426.    The first randomly chosen trivia question is selected from the data
  427.    file and is displayed to the screen.
  428.  
  429.    The player makes his selection by entering the corresponding number.
  430.    As the game progresses, SFCANTRV will provide a running total of the
  431.    correct answers and also of the wrong answers the user has selected
  432.    during the game play.
  433.  
  434.    If the ten second timer should elapse before you respond, SFCANTRV
  435.    will count this as a wrong response and add an incorrect answer to
  436.    the total WRONG answers obtained so far.
  437.  
  438.  
  439.    EXITING PLAY
  440.    ------------
  441.  
  442.    When you are ready to exit the game, simply select press "Q" for
  443.    <Q>uit.  If you qualify as one of the top ten players to date,
  444.    SFCANTRV will congratulate you for becoming one of the top ten
  445.    scorers and add your name to the Top Ten listing.  You will once
  446.    again see the Top Ten list displayed with your name added to the
  447.    list.
  448.  
  449.    If you exit the game before you have completed the twenty questions
  450.    required for eligibility to the Top Ten list or if you do not qualify
  451.    as a Top Ten player, the Top Ten listing will be displayed and you
  452.    will be prompted to press any key to return to SPITFIRE.
  453.  
  454.  
  455.    DISTRIBUTION
  456.    ------------
  457.  
  458.    Please feel free to share SFCANTRV.ZIP with others.  However, it must
  459.    be distributed with SFCANTRV.EXE, SFCANTRV.DAT, SFCANTRV.TOP,
  460.    SFCANTRV.LMT and the SFCANTRV.DOC in the SFCANTRV.ZIP distribution
  461.    package.  The files must not be altered in any way or by any means.
  462.  
  463.  
  464.    PUBLIC DOMAIN - DISCLAIMER
  465.    --------------------------
  466.  
  467.    SFCANTRV is distributed under the public domain concept.  The
  468.    software and its accompanying documentation are provided "as is"
  469.    without warranties expressed or implied as to the performance or
  470.    merchantability.  No registration fee is required and the program can
  471.    be distributed freely.  However, by the use of SFCANTRV, the user
  472.    assumes all responsibilities and agrees that Heather Story or
  473.    Electric Knights BBS or Bill Brown shall not be held liable for any
  474.    damage incurred to hardware, software or peripheral devices while
  475.    running same.
  476.  
  477.    Many thanks are indeed owed to Mike Woltz of Buffalo Creek BBS (515)-
  478.    225-8496 for his assistance.  Without his help this program would not
  479.    have been possible.
  480.  
  481.  
  482.    History
  483.    -------
  484.  
  485.    Release 1    SFCANTRV released.
  486.  
  487.  
  488.  
  489.    SFCANTRV and other SPITFIRE programs are available for download from:
  490.  
  491.         Buffalo Creek BBS                   Electric Knights BBS
  492.         Sysop - Mike Woltz                   Sysop - Bill Brown
  493.           (515) 225-8496                        (519) 442-6449
  494.        19200/9600/2400/1200                      2400/1200/300
  495.  
  496.